Fzzy Config/me.fzzyhmstrs.fzzy_config.util/Translatable

Translatable

Classes that implement Translatable can be automatically utilized by many FzzyConfig systems for generating translatable text in-game

Author

fzzyhmstrs

Since

0.2.0, added prefixes 0.6.0

Samples

import me.fzzyhmstrs.fzzy_config.util.Translatable

fun main() { 
   //sampleStart 
   class ExampleTranslatable: Translatable {
    override fun translationKey(): String {
        return "my.config.cool.translation"
    }

    override fun descriptionKey(): String {
        return "my.config.cool.translation.desc"
    }
} 
   //sampleEnd
}

Inheritors

Types

Desc

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS, AnnotationTarget.LOCAL_VARIABLE])

annotation class Desc(val value: String, val lang: String = "en_us")

Description string for data generation or used as a "fallback" description implementation. Outputs in the lang file will have the suffix ".desc". Use this on the config class itself to translate the config description for a config screen button in the landing page.

Impls

object Impls

Name

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS, AnnotationTarget.LOCAL_VARIABLE])

annotation class Name(val value: String, val lang: String = "en_us")

Name string for data generation or used as a "fallback" name implementation. Use this on the config class itself to translate the config name.

Prefix

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS, AnnotationTarget.LOCAL_VARIABLE])

annotation class Prefix(val value: String, val lang: String = "en_us")

Prefix string for data generation or used as a "fallback" name implementation. Outputs in the lang file will have the suffix ".prefix". Use this on the config class itself to translate the config prefix for a header and to put above a config screen button in the landing page.

Result

abstract class Result : Searcher.SearchContent

Abstract representation of a translation result. Implementations of this class may or may not have all three translation components

Utils

object Utils

Provides utilities for creating and caching translation results

Functions

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

abstract fun descriptionKey(): String

translation key of this Translatable description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

descriptionOrNull

open fun descriptionOrNull(fallback: String? = null): MutableText?

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered. If no translation exists when called returns null.

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasPrefix

open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

prefix

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

prefixKey

open fun prefixKey(): String

translation key of this Translatable inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

prefixOrNull

open fun prefixOrNull(fallback: String? = null): MutableText?

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered. If no translation exists when called returns null.

translation

open fun translation(fallback: String? = null): MutableText

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)

translationKey

abstract fun translationKey(): String

translation key of this Translatable. the "name" in-game

translationOrNull

open fun translationOrNull(fallback: String? = null): MutableText?

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated). If no translation exists when called returns null.